home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 49 / Amiga Format CD49 (2000-01-17)(Future Publishing)(GB)(Track 1 of 3)[!][issue 2000-02].iso / -screenplay- / otherstuff / f1gplib_dev / readme < prev    next >
Text File  |  1999-12-06  |  3KB  |  67 lines
  1. f1gp.library 36.10 (9.11.99)
  2. Copyright © 1995-1999 Oliver Roberts, All Rights Reserved.
  3. This library and the developer files are freely distributable.
  4.  
  5.   If you use f1gp.library in your program, please give me credit by
  6.   mentioning in the documentation that I wrote the library and retain
  7.   the copyright.  Thank you.
  8.  
  9.  
  10. DESCRIPTION
  11.  
  12. This library is currently used by add-on programs for MicroProse's F1GP
  13. game including F1GP-Ed, SplitTime, AGPPerf and AGPLapTime.
  14.  
  15. f1gp.library is a small library which provides a small number of functions
  16. for programmers which allow detection of F1GP and notification of a number
  17. of different events (e.g. when F1GP exits).  There is also a function which
  18. can calulate the correct file checksum.
  19.  
  20. The functions can be used after a Exec OpenLibrary(), and before your
  21. program quits you MUST close the library.  F1GPBase must also be declared,
  22. and the library base also has a few fields that can be read by your
  23. program (see include/libraries/f1gp.h).
  24.  
  25. EXAMPLE (see test.c for longer example)
  26.  
  27.    struct F1GPBase *F1GPBase;
  28.    if (F1GPBase = (struct F1GPBase *)OpenLibrary("f1gp.library",36))
  29.       CloseLibrary((struct Library *)F1GPBase);
  30.  
  31.  
  32. In addition to detecting F1GP the f1gpDetect() function will patch the
  33. following in F1GP (offsets refer to standard version):
  34.  
  35.   Offset     Bytes replaced        Description
  36.   ------     --------------        ------------
  37.   $8dc        4                    JSR before quit
  38.   $9cc        4                    JSR before quit
  39.   $a7e        4                    JSR before quit
  40.   $26dd1      11 (permanent)       Lap time calulation fix (Grant's)
  41.   $49a10      10 (no expunge)      Altered by "Use VBR" patch
  42.   $762da      8  (no expunge)      Altered by "Use VBR" patch
  43.   $76818      8  (no expunge)      Altered by "Use VBR" patch
  44.   $7e57c      8  (no expunge)      Altered by "Use VBR" patch
  45.   $7687e      8                    Exit cockpit hook
  46.   $76d1e      4  (permanent)       JSR _LVOScreenToFront(A6) => NOPs
  47.   $76d82      4  (permanent)       JSR _LVOScreenToFront(A6) => NOPs
  48.  
  49. Replacements marked with "permanent" are not restored when the library
  50. is expunged.  Those marked with "no expunge" mean that once those patches
  51. are installed the library will never be freed from memory until F1GP
  52. quits.
  53.  
  54. See f1gp.doc for descriptions of each function.  Include files for C and
  55. Assembler are supplied, and need to be used.  The proto/f1gp.h file was
  56. created for use with DICE C, and the pragmas/f1gp_pragmas.h file was
  57. generated with DICE's fdtopragma, but should be compatible with other
  58. C compilers.
  59.  
  60.  
  61. AUTHOR
  62.  
  63. f1gp.library was programmed by F1GP-Ed author, Oliver Roberts.
  64.  
  65. E-mail: oliver.roberts@iname.com
  66.    WWW: http://www.nanunanu.org/~oliver/
  67.